home *** CD-ROM | disk | FTP | other *** search
/ Atari Forever 4 / Atari Forever 4.zip / Atari Forever 4.iso / SERIE_SP / SP_016 / NEWSIE64 / NEWSIE64.ZIP / NEWSIE.DOC < prev    next >
Text File  |  1996-11-11  |  23KB  |  494 lines
  1. NEWSie - a UseNet Newsreader                          November 11, 1996
  2.  
  3. NEWSie uses the NNTP Internet protocol to read UseNet News articles.  It 
  4. provides a standard GEM interface complete with menu, windows, and mouse 
  5. selection.   
  6.  
  7. It uses STiK as the Internet access manager via SLIP connection.  Version 
  8. 0.64 provides ability to read, save, and print NEWS articles, and full 
  9. Posting and Reply capabilities.  
  10.  
  11. Articles can be downloaded and read offline.  Offline Posting and 
  12. Followup functions are now available.
  13.  
  14. Newsie supports a full complement of e-mail services, including Send, 
  15. Reply, and Forwarding of mail messages.  Multiple mailboxes are 
  16. supported, with transfer of mail between mailboxes.
  17.  
  18. NEWSie will be made available free of charge for download from several 
  19. ftp sites.
  20.  
  21. For more information:
  22. John Rojewski
  23. e-mail:    rojewski@primenet.com
  24. WWW:    http://www.primenet.com/~rojewski/
  25.  
  26.  
  27. OVERVIEW
  28.  
  29. This is an attempt to document the facilities of NEWSie, a UseNet 
  30. Newsreader client for the Atari series of computers.  NEWSie is a GEM 
  31. compliant program with standard GUI features including menus, windows, 
  32. dialogs, and mouse and keyboard input.  In addition to UseNet, NEWSie 
  33. supports e-mail send via smtp and receive via pop3 protocols.
  34.  
  35. The following major topics are included in this document:
  36. 1. MENUS
  37. 2. WINDOWS
  38. 3. DIALOGS
  39. 4. FILES
  40. 5. SETUP and USAGE
  41. 6. FUTURE ENHANCEMENTS
  42. 7. KNOW PROBLEMS
  43.     
  44.     
  45. 1. MENUS
  46.  
  47. File
  48.   The File Menu provides methods to control NewsGroup lists, Article 
  49.   Printing, and Exiting the program.
  50.  
  51. Edit
  52.   The Edit Menu contains all the standard Cut, Copy, and Paste commands.  
  53.   These are not implemented in the current NEWSie version.
  54.  
  55. News
  56.   The News Menu contains methods to select Next Article, Next Thread, 
  57.   and Next Group.  Additional items provide the ability to Post messages, 
  58.   and Followup to messages read.  Creating new e-mail, forwarding, and 
  59.   replying via e-mail is also supported.  The 'Read for Offline' item will
  60.   read all outstanding messages for all newsgroups in the current .GRP 
  61.   file.  (See Offline NewsReading below)
  62.  
  63. Special
  64.   The Special Menu contains some additional items, including the retrieval 
  65.   of the Full Group list, and any new Newsgroups.  The ability to check
  66.   your POP3 maildrop exists, via the Check Mail item, and the Get Mail item
  67.   will retrieve your mail to your system.  The mailbox structure has been 
  68.   created.  An Open In Box item will open and display a list of any 
  69.   messages received.  An Open Mailbox item provides the ability to view 
  70.   other mailboxs, including an OUTBOX, which contains a copy of all email 
  71.   which has been sent from NEWSie.  A final item (Open URL) allows you to 
  72.   retreive any Web reference (http-web page, graphic, etc.) from within 
  73.   NEWSie.
  74.  
  75. Preferences
  76.   The Preferences Menu supplies a variety of areas that the user needs to 
  77.   change to configure NEWSie to work with his/her Internet Service Provider 
  78.   (ISP) and also to allow the user to define some defaults for system 
  79.   operation.  Most selections present a Dialog to the user.
  80.  
  81.  
  82. 2. WINDOWS
  83.  
  84. Subscribed NewsGroups
  85.   The Subscribed NewsGroups window displays the NewsGroups that you have 
  86.   selected to be kept aware of new articles.  A NewsGroup is a category of 
  87.   messages that (should) relate to some topic.
  88.   There are many thousands of NewsGroups, and not all News Servers (ISPs) 
  89.   offer all NewsGroups.  You may manually enter the name of a NewsGroup you 
  90.   are interested in viewing, or in combination with the Full NewsGroup 
  91.   and New NewsGroup windows, Subscribe to additional NewsGroups.
  92.   If your ISP does not support a particular newsgroup in the Subscribed 
  93.   Newsgroups list, it will be marked with a '?' in the first column of the
  94.   display.   You may select such a group, but the only action that may be
  95.   performed is to UnSubscribe.
  96.  
  97. Article Overview
  98.   For any given NewsGroup, selecting that NewsGroup via a double-click or 
  99.   Return Key in the Subscribed NewsGroup window will fetch the Article 
  100.   Overview list from the News Server.  This list is displayed in the 
  101.   Article Overview window.  The overviews are formatted with: 
  102.      Article number
  103.      Subject
  104.      Author
  105.      Date of submission
  106.      Number of lines of message text
  107.   Any of the overviews can be selected via mouse click or keyboard up and
  108.   down arrow keys.  When selected, the article overview is displayed in 
  109.   color RED (subject to preferences).
  110.   A double-click or Return key will fetch the selected Article from the 
  111.   News Server.
  112.   Article Threads are recognized.  Threads are a group of related articles,
  113.   and are marked with a '+' for the primary article, and '-' for subordinate
  114.   articles.  Threads formatting is dependent upon the Newsreading Preferences
  115.   'Create Threads' and 'Collapse Threads'.  If 'Create Threads' is un-selected,
  116.   then Thread processing is bypassed and articles are shown in numeric
  117.   (ascending) order.  If 'Create Threads' alone is selected, both the primary
  118.   ('+') articles and subordinate ('-') articles will be displayed.  If the 
  119.   'Collapse Threads' option is selected, only the primary ('+') articles  
  120.   will be displayed.
  121.   The left and right arrow keys control the expansion and/or collapse of
  122.   individual threads.  Selecting a primary article and pressing the right 
  123.   arrow key will display all subordinate articles for that thread.  Clicking
  124.   the left arrow on the primary, or any subordinate article, will collapse
  125.   the thread back to just the primary article.
  126.  
  127. Article Text
  128.   The Article Text window displays a News Article.  The article contains a 
  129.   header and the message body.  The header contains lines such as: Author, 
  130.   Subject, Date, etc.  The body contains the message response entered by 
  131.   the author.  Each article read is available on your local disk as 
  132.   'NNNNNN.TXT', where NNNNN is the Article number.  These files can be 
  133.   deleted by you as you choose by pressing the Del key within the window.
  134.   This provides a method to keep un-wanted messages from accumulating.
  135.  
  136.   If you prefer an external viewer program instead of the builtin window, 
  137.   you may select a viewer program from the Preferences menu in the Path
  138.   Preferences dialog (External Viewer Path).  Once this is done, selecting
  139.   'Use External Viewer' in the Newsreading Options dialog will cause NEWSie
  140.   to call the external program with the article filename.
  141.  
  142. Offline Newsreading
  143.   NEWSie supports offline newsreading with version 0.60.  The menu item
  144.   'Read for Offline' will read all outstanding articles in all newsgroups 
  145.   in the current Subscribed Newsgroups window.  Warning:  until you are 
  146.   familiar with the operation of this program, the author suggests you 
  147.   limit the number of newsgroups/articles to some finite number less than 
  148.   ten newsgroups and a total of 100 articles.   A maximum of 400 articles 
  149.   can be maintained for each newsgroup (if you have the disk space!).
  150.  
  151.   The 'Read for Offline' menu item is used while online (connected to your 
  152.   mail server) and will build a set of files and directories in the 
  153.   directory you have named as the 'Offline Path' (see Path Preferences).
  154.   The Escape key is active, and will abort this function at any time.
  155.  
  156.   After reading the articles, Quit NEWSie, Disconnect STiK, and start 
  157.   NEWSie again.  This time, you will be able to view the articles saved on 
  158.   disk in the same way as online articles.  The delete key will delete 
  159.   articles on disk, and also remove the entry in the Overview window when 
  160.   the window is closed.
  161.   
  162.   Offline Posting of new articles, and Followups to articles read is now 
  163.   supported.  These articles are created as the result of a Post/Followup 
  164.   followed by a Send when there is no connection to the News Server. 
  165.   At the next time there is a connection to the News Server, these 
  166.   articles are transmitted, and deleted from your system.
  167.    
  168.   To view the articles waiting to be Posted, use the 'Open Offline 
  169.   PostBox' item in the News menu.  This will open the PostBox (if it 
  170.   exists) and allow you to view the articles, and/or delete them before 
  171.   they are sent via the 'Delete' key.
  172.   
  173.   There are (currently) no preference controls on this function. 
  174.  
  175.    
  176. New NewsGroups
  177.   The New NewsGroups window displays a list of NewsGroups created after a 
  178.   certain Date and Time.  The data and time are entered by the user in a 
  179.   dialog.  This list can be referenced and any of the NewsGroup names 
  180.   can be selected, and Subscribed to.  When the Subscribe is performed, the 
  181.   NewsGroup name is added to the Subscribed NewsGroup window, and is 
  182.   immediately available for use.  A double-click with the left mouse button,
  183.   or selecting Subscribe from the Special menu performs the Suscribe function.
  184.  
  185. Full NewsGroups
  186.   The Full NewsGroups window serves a similar purpose, but contains a 
  187.   complete list of all NewsGroups available from your News Server.  Because 
  188.   this file can be very large, it may take several minutes to fetch it. 
  189.   The same selection and subscription ability exists for this window as for 
  190.   the New NewsGroups window.
  191.   
  192. MailBox
  193.   The Mailbox window displays the contents off various mailboxes.  Two 
  194.   Mailboxes are provided by NEWSie, the InBox and the OutBox.  The InBox 
  195.   contains a list of all emails received via the Get Mail Menu title.  
  196.   After receiving mail, clicking on the Open In Box will display the 
  197.   messages with a 'U' (unread) in the first column.  Double-clicking on 
  198.   any message line will open the Mail Text window (see below).  Arrow keys 
  199.   will move up or down in the list, and the return key will also select 
  200.   the current mail message.  The delete key will mark the item for 
  201.   deletion when the window is closed.
  202.  
  203.   A 'transfer' from any mailbox to any other mailbox (including creating a 
  204.   new mailbox) by pressing the 't' key.  To create a new MailBox, enter 
  205.   the Mailbox name followed by '.MBX' in the file selector (i.e. NEW.MBX).
  206.   (Of course the name can be anything, but NEWSie will only look for MBX 
  207.   files by default.)
  208.   
  209. Mail Text
  210.   This window displays the content of any of the selected Mailboxes.  This 
  211.   window is shown unless the 'Use External Viewer' option is selected.  
  212.   The delete key serves the same function as in the MailBox window, 
  213.   namely, to delete the current mail message when the MailBox window is 
  214.   closed.   
  215.  
  216.  
  217. 3. DIALOGS
  218.  
  219. Personal Preferences
  220.   The Personal Preferences dialog provides the ability to enter information 
  221.   about the user.  Fields include:
  222.      Full Name
  223.      Organization name
  224.      E-mail address
  225.  
  226. Server Preferences
  227.   The Server Preferences dialog provides the ability of the user to specify 
  228.   information about the Internet servers that will be used to access the 
  229.   News and Mail systems.  Fields include:
  230.      NewsServer name
  231.      MailServer name
  232.      Connect to NewsServer on startup switch
  233.      2 TCP/IP timeout values
  234.  
  235. News Reading Preferences
  236.   The News Reading Preferences dialog provides the user with several 
  237.   options pertaining to the method by which NEWSie will display News 
  238.   Articles on the user's screen.  Fields include:
  239.      Display the article header lines
  240.      Maximum number of messages to read
  241.      Use External Viewer
  242.      Create Threads
  243.      Collapse Threads
  244.      Most recent 'n' articles
  245.      Allow Offline Newsreading
  246.      
  247. Mail Preferences
  248.   The Mail Preferences include several features for storing and 
  249.   manipulating e-mail.  fields include:
  250.      Delete Mail from Server after Receipt
  251.      Use a saved password
  252.      The user's password (saved in the Prefs file)
  253.      Send Queued Output at Check_Mail
  254.      Delete Queued Output after being sent
  255.      
  256. Message Preferences
  257.   The Message Preferences dialog provides the user with several options 
  258.   pertaining  to the method for responding to Articles read.  These include:
  259.      Followup to NewsGroup
  260.      Reply to the article's author via e-mail
  261.      Send copy to yourself via e-mail
  262.      Character(s) to indicate a quote
  263.  
  264. Path Preferences
  265.   The Path Preferences dialog allows the user to specify where additional 
  266.   files, articles, etc. should be stored in the user's computer file system.
  267.   These include:
  268.      Work Path
  269.      Mail Path (for e-mail)
  270.      Offline Path (for offline newsreading)
  271.      External Editor Program
  272.      External Viewer Program
  273.   Note: The Titles are also selectable, and they allow the same 
  274.   functionality as selecting the Path objects they represent.
  275.  
  276. Log Preferences
  277.   The Log Preferences dialog allows the user to specify how much or how 
  278.   little information is recorded about the actual activity of NEWSie in 
  279.   retrieving and replying to articles.  In general, there is little 
  280.   information in the Log for casual users, and most users will not need to 
  281.   change these preferences.
  282.  
  283. Signature Preferences
  284.   The Signature Preferences dialog is provided to allow users to suffix any 
  285.   reply or posted responses with their selected signature.  The filepath
  286.   displayed indicates the current signature file, and the first several lines
  287.   of text are displayed.  Clicking on the filename allows the user to select 
  288.   a new signature file.  As with the Path Preferences dialog above, the 
  289.   Signature Path title is also selectable, and provides the same 
  290.   functionality as selecting the filename object.
  291.  
  292. Font Preferences
  293.   The Font Preferences dialog is provided to allow the user to vary the font
  294.   displayed in the NewsGroup, Overview, and Article windows.  For those users
  295.   the have some version of GDOS (including NVDI), they may select any of several
  296.   font faces and point sizes.  Clicking on the arrow box on the right of the
  297.   font name will 'drop down' a font selection list.  Arrow buttons in the list
  298.   allow for scrolling.  Clicking on any font name will select that font for use.
  299.  
  300.   In the event that the chosen font does not exist in a particular configuration,
  301.   the default system font will be used instead.
  302.   
  303. Transfer Status
  304.   The Transfer Status dialog is an output only dialog provided to give the 
  305.   user visual feedback of data transfers as they occur.  This is status is 
  306.   available whenever there is information being received from the servers, 
  307.   or being sent to the servers.  The Transfer Status display may be disabled
  308.   by un-selecting the 'Show Status' option in the Newsreading Preferences 
  309.   dialog.
  310.  
  311. Full NewsGroup Warning
  312.   The Full NewsGroup Warning dialog is provided to warn the user that this 
  313.   transfer can take a long time and use a lot of disk space.
  314.  
  315. Full NewsGroup Re-load
  316.   The Full NewsGroup Re-load dialog is provided to allow the user to use 
  317.   the existing Full NewsGroup list or download a new one.  Using the 
  318.   existing file is much faster.
  319.  
  320. New NewsGroup Selection
  321.   The New NewsGroup Selection dialog is provided to allow the user to see 
  322.   any NewsGroups that have been created since a specified date.  This, in 
  323.   combination with the Full NewsGroup list, will allow the user to access 
  324.   new NewsGroups as they become available.
  325.  
  326. Subscribe to NewsGroup
  327.   The Subscribe to Newsgroup dialog is presented in several situations:
  328.      double-click in the Full Newsgroups window
  329.      double-click in the New Newsgroups window
  330.      The Subscribe Menu title
  331.      Insert key in the Subscribed Newsgroups window
  332.   In the first 2 cases, the Newsgroup name will be displayed. Clicking on
  333.   the OK button will enter the Newsgroup into the current Subscribed NewsGroup
  334.   file (i.e DEFAULT.GRP, or other).  The 3rd case (Subscribe Menu) can be used
  335.   instead of the double-click, but may also be used at any time to allow the
  336.   user to type in the name of a Newsgroup.  The 4th case (Insert key) will
  337.   also allow the user to type in a Newsgroup name.  Note that if the 
  338.   Newsgroup name is invalid or unsupported by your ISP, the current Subscribed
  339.   Newsgroup file/window will not be updated.
  340.  
  341. UnSubscribe from Newsgroup
  342.   The UnSubscribe from Newsgroup dialog is presented in the following
  343.   situations:
  344.     The UnSubscribe Menu title
  345.     Delete key in the Subscribed Newsgroups window
  346.   In either case, the currently selected Newsgroup is displayed in the
  347.   dialog with question 'UnSubscribe from Newsgroup?'.  Pressing the OK
  348.   button deletes the Newsgroup from the Subscribed window and file.     
  349.  
  350. STiK Disabled
  351.   The STiK Disabled dialog is displayed at startup when the STiK accessory 
  352.   is not 'enabled'.  STiK must be enabled and most likely connected to the 
  353.   user's Internet Service Provided (ISP) before NEWSie can access new 
  354.   articles.
  355.  
  356.  
  357. 4. FILES
  358.  
  359. Resource
  360.   The NEWSIE.RSC file is required for operation.  It should be in the same 
  361.   directory as NEWSIE.PRG.  This file contains all of the Menu and Dialog 
  362.   definitions.  There should be no reason for the user to modify this file 
  363.   in any way.  This should make it easier to produce non-English versions 
  364.   of NEWSie with little or no program changes.
  365.  
  366. Support Program(s)
  367.   With NEWSie 0.54, the UUD.TTP program is provided.  It should be placed in
  368.   the directory configured as the Work Path.  This program provides the 
  369.   service of decoding any UUEncoded data in retrieved messages.  This encoded 
  370.   data is most generally a binary file (picture or program).  The 'Extract 
  371.   Binaries' menu item in the Special Menu uses this program.
  372.  
  373. Preferences
  374.   The PREFS.INF file is required for proper operation. It should be in the 
  375.   same directory as NEWSIE.PRG.  There is a generic PREFS.INF file in the 
  376.   distribution.  Feel free to use this as the basis for configuring NEWSie 
  377.   to your preferences.  See the individual Preference dialogs for any 
  378.   specific options available.
  379.  
  380.   Note that NEWSie will automatically update your existing PREF.INF file 
  381.   to include all of the most recent parameters when you execute a more 
  382.   current version of NEWSie.
  383.  
  384. Subscribed NewsGroups
  385.   The DEFAULT.GRP file is required for proper operation.  There is a 
  386.   generic DEFAULT.GRP file in the distribution.  You may add new NewsGroups 
  387.   to this, and delete ones you are not interested in subscribing to.  You 
  388.   may have several Subscribed NewsGroup files, and use them interchangeably.
  389.   The DEFAULT.GRP will be used by NEWSie at startup.  A GRP file can 
  390.   contain a maximum of 100 newsgroup names.
  391.  
  392. Full NewsGroups
  393.   The FULLGRP.TXT file is an optional file.  It is optional because it can 
  394.   be extremely large, possibly larger than 1 Meg.  This file is retrieved 
  395.   from your selected News Server only if you request it.  Once retrieved, 
  396.   it is used until you request it again.  This file will contain a listing 
  397.   of all the NewsGroups that are available for subscription from your News 
  398.   Server.
  399.  
  400. MailBoxes and Mail
  401.   A MAIL path is available in the Path Preferences.  Within this path 
  402.   NEWSie will establish MailBoxes and Mail messages.  MailBoxes are 
  403.   expected to have a suffix of .MBX, and Mail messages will be in the form 
  404.   MAILnnnn.TXT, where nnnn is a unique number from 0000-9999.
  405.   A mailbox can contain a maximum of 100 messages.
  406.   
  407. Log
  408.   The LOG file is a temporary file created by NEWSie during its processing. 
  409.   It is of most interest to the author and to others who want more 
  410.   information about the workings of NEWSie and other UseNet news reader 
  411.   programs and the associated commands, protocol, etc.  The Log Preferences 
  412.   dialog will allow you to configure the information put into this file as 
  413.   you choose.
  414.  
  415. Offline Articles
  416.   If you choose to use the Offline Newsreading features, you should 
  417.   specify a Offline Path directory (OFFLINE is included in the 
  418.   distribution file).  NEWSie will create a set of directories under the 
  419.   selected Offline path for each newsgroup that can have offline articles.
  420.   The names of these directories are a 'compression' of the newsgroup 
  421.   name.  The articles are placed in the respective directory in the same 
  422.   format as for online articles ('NNNNNN'.TXT') in separate files.
  423.  
  424. Offline Posts and Followups
  425.   Articles are saved in files named 'POSTNNNN.TXT' in the WorkPath.
  426.   An index of these files is called 'POSTS.PBX' (PBX being similar  
  427.   to MBX, meaning PostBoX).  These files are created as the result of a 
  428.   Post/Followup followed by a Send when there is no connection to the News 
  429.   Server.  At the next time there is a connection to the News Server, 
  430.   these files are transmitted, and deleted from your WorkPath.  If before 
  431.   you connect to the News Server, you decide to refrain from Posting 
  432.   something, you should use the 'Open Offline PostBox menu item in the 
  433.   News menu to review and/or delete the offending file(s) via 'Delete' key.
  434.  
  435.   
  436.  
  437. 5. SETUP and USAGE
  438.  
  439. Several things are necessary to use NEWSie from the distribution ZIP file.
  440.  
  441. 1. Unzip the NEWSIEnn.ZIP file and move to where ever you want it.
  442. 2. Enable STiK if it is installed.  If you don't have STiK installed, you 
  443.    will not be able to perform any Online activities with NEWSie.
  444. 3. Double-click on NEWSIE.PRG
  445. 4. Immediately go to the Preferences Menu and fill in the following:
  446.      Personal Preferences
  447.      Server Preferences (especially the NewsServer name)
  448.      Path Preferences for editor and viewer usage, MAIL and OFFLINE path
  449.      Other Preferences as you choose
  450.      Save Preferences
  451. 5. Quit NEWSie via Quit in File menu
  452. 6. If not already connected to the Internet (via STiK dialer), do so.
  453. 7. Execute NEWSie again, hopefully getting a connection to your NewsServer.  
  454.    If you have selected 'Connect at Startup' in the Server Preferences, 
  455.    this should occur automatically, otherwise, use the 'Manual Connect' 
  456.    item in the Special Menu.
  457. 8. Report problems to:  rojewski@primenet.com.
  458.  
  459.  
  460. 6. FUTURE ENHANCEMENTS
  461.  
  462. Enhancements to NEWSie are planned.  The current package is continuously
  463. being improved.  (Unfortunately there are only so many hours of programming
  464. time in a week...)
  465.  
  466. Some acknowledged areas of weakness are:
  467.      Stability/bombs/lockups
  468.      Documentation of features (i.e this document)
  469.      Extract Binary data  (only UUDecode support)
  470.      News Article management
  471.      Attachments (and encoding support)
  472.      Mail cc: and bcc:
  473.      Authentication/Security
  474.  
  475. See IMPROVE.DOC for a survery of suggested improvements.
  476.      
  477.      
  478. 7. KNOWN PROBLEMS (0.62)
  479.      Atari Works cannot be used as external editor/viewer
  480.      Problems with re-opening windows after closing them 
  481.      Random bombs (w/New Newsgroups/Full Newsgroups while offline)
  482.      Lockups with no option but to re-boot
  483.  
  484. See HISTORY.DOC to see what has changed since the previous version(s).
  485.  
  486.  
  487.  
  488.  
  489.     
  490.  
  491.  
  492.     
  493.  
  494.